PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

people

Creates a people resource.

Authorizations:

JWT

path Parameters

required

string

people identifier

Request Body schema:
application/ld+json
required

The new people resource

logEntries	Array of strings <iri-reference> [ items <iri-reference > ]
timestamp	string <date-time>
corporations	Array of strings <iri-reference> [ items <iri-reference > ]
companyType	string or null <iri-reference>
user	Array of strings <iri-reference> [ items <iri-reference > ] Get user's login
partner	Array of strings <iri-reference> [ items <iri-reference > ]
employee	Array of strings <iri-reference> [ items <iri-reference > ] Get employee.
client	Array of strings <iri-reference> [ items <iri-reference > ]
contact	Array of strings <iri-reference> [ items <iri-reference > ]
supplier	Array of strings <iri-reference> [ items <iri-reference > ] Get supplier.
shipper	Array of strings <iri-reference> [ items <iri-reference > ] Get shipper.
competitor	Array of strings <iri-reference> [ items <iri-reference > ]
prospect	Array of strings <iri-reference> [ items <iri-reference > ]
applicant	Array of strings <iri-reference> [ items <iri-reference > ]
corporation	Array of strings <iri-reference> [ items <iri-reference > ]
coordinates	Array of strings <iri-reference> [ items <iri-reference > ] Get coordinates.
followups	Array of strings <iri-reference> [ items <iri-reference > ]
inventoryEntries	Array of strings <iri-reference> [ items <iri-reference > ]
currency	string <iri-reference> Get currency.
bills	Array of strings <iri-reference> [ items <iri-reference > ] Get bills.
firstName	string or null
lastName required	string or null
notes	string or null
authorNotes	Array of strings <iri-reference> [ items <iri-reference > ]
authorComments	Array of strings <iri-reference> [ items <iri-reference > ]
participantNotes	Array of strings <iri-reference> [ items <iri-reference > ]
personSkills	Array of strings <iri-reference> [ items <iri-reference > ]
approvals	Array of strings <iri-reference> [ items <iri-reference > ]
importJobs	Array of strings <iri-reference> [ items <iri-reference > ]
deletedAt	string or null <date-time>
slug required	string DB Identifier
customProperties	any Can contain anything (array, objects, nested objects...).
customData	Array of strings or null
createdAt	string <date-time>
updatedAt	string <date-time>
disabledAt	string or null <date-time>
	object (Collection.jsonld)
upload_filename	string
upload_subfolder	string
upload_file	string
upload_file_link	string
login	string or null <iri-reference> Get login.
upload_Subfolder	string
upload_File	string
upload_File_Link	string

Responses

Request samples

Payload

Content type

application/ld+json

{"logEntries": ["https://example.com/"
],
"timestamp": "2019-08-24T14:15:22Z",
"corporations": ["https://example.com/"
],
"companyType": "https://example.com/",
"user": ["https://example.com/"
],
"partner": ["https://example.com/"
],
"employee": ["https://example.com/"
],
"client": ["https://example.com/"
],
"contact": ["https://example.com/"
],
"supplier": ["https://example.com/"
],
"shipper": ["https://example.com/"
],
"competitor": ["https://example.com/"
],
"prospect": ["https://example.com/"
],
"applicant": ["https://example.com/"
],
"corporation": ["https://example.com/"
],
"coordinates": ["https://example.com/"
],
"followups": ["https://example.com/"
],
"inventoryEntries": ["https://example.com/"
],
"currency": "https://example.com/",
"bills": ["https://example.com/"
],
"firstName": "string",
"lastName": "string",
"notes": "string",
"authorNotes": ["https://example.com/"
],
"authorComments": ["https://example.com/"
],
"participantNotes": ["https://example.com/"
],
"personSkills": ["https://example.com/"
],
"approvals": ["https://example.com/"
],
"importJobs": ["https://example.com/"
],
"deletedAt": "2019-08-24T14:15:22Z",
"slug": "string",
"customProperties": null,
"customData": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"disabledAt": "2019-08-24T14:15:22Z",
"entityFiles": { },
"upload_filename": "string",
"upload_subfolder": "string",
"upload_file": "string",
"upload_file_link": "string",
"login": "https://example.com/",
"upload_Subfolder": "string",
"upload_File": "string",
"upload_File_Link": "string"
}

Response samples

Content type

application/ld+json

{"@context": "string",
"@id": "string",
"@type": "string",
"timestamp": "2019-08-24T14:15:22Z",
"companyType": {"@context": "string",
"@id": "string",
"@type": "string",
"parent": { },
"shortcode": "CT",
"deletedAt": "2019-08-24T14:15:22Z",
"id": 0,
"slug": "string",
"customData": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"disabledAt": "2019-08-24T14:15:22Z",
"number": "string",
"priority": 0,
"color": "string",
"icon": "string",
"notes": "string",
"parameterTitle": "string",
"root": 0,
"lvl": 0,
"lft": 0,
"rgt": 0,
"toString": "string",
"translationDescriptionPropertyName": "string",
"childrenListing": "string",
"leaf": true,
"leafApi": true,
"levelApi": 0,
"anonymousToken": "string",
"uniqueId": "string",
"taggingListing": "string",
"enabled": true,
"disabled": true
},
"currency": {"@context": "string",
"@id": "string",
"@type": "string",
"notes": "string",
"shortcode": "CU",
"deletedAt": "2019-08-24T14:15:22Z",
"id": 0,
"slug": "string",
"customData": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"disabledAt": "2019-08-24T14:15:22Z",
"number": "string",
"priority": 0,
"color": "string",
"icon": "string",
"parameterTitle": "string",
"toString": "string",
"translationDescriptionPropertyName": "string",
"anonymousToken": "string",
"uniqueId": "string",
"taggingListing": "string",
"enabled": true,
"disabled": true
},
"firstName": "string",
"lastName": "string",
"notes": "string",
"shortcode": "U",
"deletedAt": "2019-08-24T14:15:22Z",
"id": 0,
"slug": "string",
"customData": ["string"
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"disabledAt": "2019-08-24T14:15:22Z",
"toString": "string",
"personFullName": "string",
"inventoryEntriesListing": "string",
"personDefaultCoordinate": null,
"corporationsListing": "string",
"coordinatesListing": "string",
"billsListing": "string",
"userListing": "string",
"followupsListing": "string",
"partnerListing": "string",
"clientListing": "string",
"competitorListing": "string",
"contactListing": "string",
"applicantListing": "string",
"prospectListing": "string",
"shipperListing": "string",
"employeeListing": "string",
"supplierListing": "string",
"personSkillsListing": "string",
"authorNotesListing": "string",
"participantNotesListing": "string",
"approvalsListing": "string",
"authorCommentsListing": "string",
"anonymousToken": "string",
"uniqueId": "string",
"taggingListing": "string",
"enabled": true,
"disabled": true
}

PHPR API (3.7.0)

people

Creates a people resource.

Authorizations:

path Parameters

Request Body schema: application/ld+jsonapplication/hal+jsonapplication/vnd.api+jsonapplication/jsontext/htmltext/csvapplication/ld+jsonrequired

Responses

Request samples

Response samples

Request Body schema:
application/ld+json
required